Skip to content

Docs - #17

Closed
RobotOptimist wants to merge 24 commits into
featherhttp:masterfrom
RobotOptimist:docs
Closed

Docs#17
RobotOptimist wants to merge 24 commits into
featherhttp:masterfrom
RobotOptimist:docs

Conversation

@RobotOptimist

Copy link
Copy Markdown
Contributor

Okay, I finally got this done.
#7

Deployment

This puts the static site generator into the docs folder in the regular project.
Regarding the deployment: on push to master, the new ci job will generate the static site and then deploy it to a gh-pages branch
Stuff you'll need to do:

  • You will need to create a gh-pages branch
  • You will need to create a personal access token with repo permissions

Stuff you may want to do

  • You may want to change the event to pull-request depending on how you want people to contribute to docs
  • You may want to create a dedicated branch for modifying docs ( a docs branch? )

Be aware also that github pages use case sensitive routes so it's going to be https://davidfowl.github.io/FeatherHttp
just fyi that https://davidfowl.github.io/featherhttp will not work.
Once you've done your first successful deployment from the ci build to gh-pages you can configure github to create your docs site

Local dev

This will go into the contribution guide as well, but you can build and run this from the docs folder after you pull it down to your local environment

  1. npm install
  2. npm run dev
  3. navigate to http://localhost:3000

you can deploy changes directly to the gh-pages from your local by doing this:

  1. npm run generate:gh-pages
  2. npm run deploy

Content

I've got a rudimentary getting started section and I'm working on a docs contribution guide + cleaning up the syntax a bit.

This is using tailwind.css similar to the go site you wanted to model off of, but we can switch to bootstrap.css if you want to make this easier for people to add custom styles since lots of people know bootstrap.

Otherwise, I can make the example pages markdown friendly by including another plugin and then contributors can add to the docs files in markdown.

If we want to get really fancy then I can try to devise a way to pull in the .md files from each sample and dynamically create these vue files from that. Not sure how brittle that would be - but I might able do it if you want that.

Comment thread .github/workflows/ci.yaml Resolved
@RobotOptimist

Copy link
Copy Markdown
Contributor Author

I've got other enhancements I want to make to this anyway, I'm closing this

@RobotOptimist RobotOptimist mentioned this pull request Feb 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants